home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / comm2 / umsfid20.lha / UMS / Doc / English / UMSFido.doc < prev   
Text File  |  1995-07-29  |  19KB  |  603 lines
  1. Documentation for FidoExport and FidoImport 2.0
  2. """""""""""""""""""""""""""""""""""""""""""""""
  3.  
  4. General Information
  5. ===================
  6.  
  7. To  run  a  fido system with UMS you need FidoImport, FidoExport,
  8. TrapDoor and (of course) UMS itself with an UMS-newsreader.
  9.  
  10. FidoImport  imports  Fidomessages  which  are transported via the
  11. program  TrapDoor  into  the  UMS-messagebase.   New messages are
  12. exported  with  FidoExport from the UMS-messagebase and converted
  13. into a format which can be sent with TrapDoor.
  14.  
  15. The  description  of  the structure of this so-called packetfiles
  16. can   be  found  in  the  Fidopapers  (FSC-files).   The  nameing
  17. conventions  of  the  different  filetypes  can  be  found in the
  18. TrapDoor manual.
  19.  
  20. Installation - necessary Libraries
  21. ==================================
  22.  
  23. The following Libraries are needed to use UMSFido:
  24.  
  25. - traplist.library (at least V5.0)
  26.  
  27. This does not mean that there has to be a nodelist present.
  28.  
  29. Installation - config variables
  30. ===============================
  31.  
  32. FidoImport and FidoExport are configured with variable entries in
  33. the  config  file  ums.config.  You have to produce an user entry
  34. for each system you are connected with which uses Fidotechnology.
  35. To  do  so you have to set up the following config variables.  An
  36. asterisk (*) means the variable is optional.
  37.  
  38.  
  39.     fido.netName
  40.  
  41. Name  of  the  network using "Fido technology".  It is used as an
  42. identification  for  the  groups  ("netname.group")  and adresses
  43. ("z:n/f.p@netname")  which  are used within this net.  In Fidonet
  44. you  simply  fill  in  "fidonet".   The  entries "READACCESS" and
  45. "WRITEACCESS"  of  the  related  user  have to be set accordingly
  46. (e.g.  READACCESS "fidonet.#?").  Don´t forget to set up "export"
  47. also (e.g.  export "#?@fidonet").
  48.  
  49. Important:   This  entry is also used to identify a FTN exporter.
  50. Therefore it must be a local entry.
  51.  
  52.  
  53.    fido.localAddress
  54.    fido.fakeAddress (*)
  55.    fido.stoneAge (*)
  56.  
  57. The   localaddress   and   the   fakeaddress   describe  the  own
  58. Fidoaddress.   You  only  have  to  set up the fakeaddress if the
  59. software  of the Fido system you communicate with can not process
  60. 4D-packets.   If  you  set  Stoneage  to "y" the system will only
  61. produce  3D-packets.  Please don´t forget to add an AKA entry for
  62. each  address.
  63.  
  64.  
  65.    fido.remoteAddress
  66.  
  67. Fidoaddress of the receiver you are going to call.
  68.  
  69.  
  70.    fido.mausGate (*)
  71.    fido.rfcGate (*)
  72.  
  73. Fidoaddresses   of   the   Maus-gateway  and  RFC-gateway.   This
  74. addresses  are necessary if private messages to Maus-addresses or
  75. RFC-addresses are to be exported by FidoExport.
  76.  
  77.  
  78.    fido.defaultOrigin (*)
  79.  
  80. This is the origin which will be used if a message dosn't have an
  81. origin.
  82.  
  83.  
  84.    fido.inbound
  85.    fido.outbound
  86.    fido.tmpDir (*)
  87.  
  88. Directorypaths  for incoming and outgoing packets and for packets
  89. which  are  just  being  processed.   All  directories must exist
  90. before you start the program.  Default for fido.tmpDir is "T:".
  91.  
  92.  
  93.    fido.nodelist (*)
  94.  
  95. Directorypath  for  the nodelist.  This variables are only needed
  96. if  you  run  a  node.   If you export Crash-mails to points then
  97. FidoExport  will  look  up  the  address in the nodelist.  If the
  98. point  is  found in the nodelist the message is exported directly
  99. to  the  point´s  address else the message is sent to the point´s
  100. boss.
  101.  
  102.  
  103.    fido.arcCmd
  104.    fido.dearcCmd
  105.    fido.junkCmd
  106.  
  107. AmigaDOS   commands   for   compressing   and   uncompressing  of
  108. Fidonet-packets.   For  defective  packets  fido.junkCmd  will be
  109. executed.   Each  command  can  contain  a  variable (substitute)
  110. starting with "%" which will be replaced with a certain value.
  111.  
  112.  
  113. Substitutes valid with fido.arcCmd:
  114. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  115. %arcName : name of compressed file
  116. %pktName : name of processed Fidopaket
  117.  
  118.  
  119. Substitutes valid with fido.dearcCmd:
  120. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  121. %dirName   : name of destinationdirectory for the uncompressed file
  122. %dearcName : name of file to be uncompressed
  123.  
  124. Substitutes valid with fido.junkCmd:
  125. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  126. %dearcName : name of file to be uncompressed
  127.  
  128.  
  129.    fido.maxPktSize (*)
  130.  
  131. You  can  limit  the maximum size of the uncompressed packet with
  132. this value.  The value means the size in bytes.
  133.  
  134.  
  135.    fido.charset.xy (*)
  136.  
  137. FidoImport  processes  ALL  in FSC 54 defined charsets.  Although
  138. not  all Fidousers and Fidoprogramms stick to the specifications.
  139. Hence an ´alias´ for charsets is possible.
  140.  
  141. The charset ("xy") which does not comply the specification can be
  142. given the value of an appropriate charset. Aknowledged are
  143. "LATIN-1",  "IBMPC",  "MAC"  for  8-Bit  special  characters  and
  144. "GERMAN",  "FRENCH",  "DUTCH",  "FINNISH", "CANADIAN", "ITALIAN",
  145. "NORWEG",  "PORTU",  "SPANISH",  "SWEDISH",  "SWISS" and "UK" for
  146. 7-Bit special characters.  Anything else does not comply with FSC
  147. 54 but can be redirected to a correct chartable.
  148.  
  149.  
  150.    fido.ascii (*)
  151.    fido.ibmpc (*)
  152.  
  153. Each  may  contain  a pattern to specify groups in which messages
  154. written  by  local users are not to keep the LATIN-1 charset when
  155. exported.    Instead,   FidoExport   will   replace  all  special
  156. characters with their equivalents from ASCII or the international
  157. "IBMPC" charset, respectively.
  158.  
  159.  
  160.    fido.security (*)
  161.  
  162. This  string  contains  an unlimited amount of flags which enable
  163. several levels of security.  At present the following are known:
  164.  
  165.  
  166.   PKTADR -     Import packets only, if the destination address is
  167.                one of your own 4D-addresses or Fakeaddresses.
  168.  
  169.   PKTPWD -     if logged in the password contained in the packet
  170.                must also be correct. (Otherwise the password ""
  171.                would be tried for UMSLogin () ).
  172.  
  173.   SESSIONPWD - a login with password "" via the address taken from
  174.                the TrapDoor filenote is only attempted if the
  175.                transmission was password protected.
  176.  
  177.  
  178. By  using  PKTPWD and SESSIONPWD you can limit access to special,
  179. higher   priviledged  UMS  user  accounts  to  authorized  users.
  180. Packets  whose  origin  is  unknown  or  which  don´t  come  from
  181. authorized  sources  can  be  processed  by  the less priviledged
  182. default-login.
  183.  
  184. These  security aspects are of course only interesting for nodes,
  185. who  want  to  be  able to maintain the password protected status
  186. with nodes and points for e.g.  Crashmail also.
  187.  
  188.  
  189.    fido.debugLevel (*)
  190.    fido.logLevel (*)
  191.    fido.reportLevel (*)
  192.    fido.reportUser (*)
  193.    fido.reportFolder (*)
  194.  
  195. FidoImport  and FidoExport produce three different kinds of debug
  196. and   log  information:   to  standard  output  (debuglevel),  to
  197. UMS-logfile (loglevel) and in a mail (report-level) which is sent
  198. to  the  user  specified  (reportuser).   You  can also specify a
  199. folder (reportfolder) for these mails.
  200.  
  201. The  levels  are likewise to the levels of the UMS-server:  small
  202. values  only  log  important  information  or  severe errors, big
  203. values  also  include  less important information and and smaller
  204. errors.  0-4 only include errors and 5-9 include some general log
  205. and debug information.
  206.  
  207. E.g. "fido.debugLevel = 9" will produce verbose information about
  208. every processed packet.
  209.  
  210.  
  211.    fido.route (*)
  212.  
  213. This  entry  is  only  necessary if you run a node.  It holds the
  214. routing information for private messages and looks like this:
  215.  
  216. <Pattern>       <Nodenumber>    <Type>
  217. <Pattern>       <Nodenumber>    <Type>
  218. <Pattern>       <Nodenumber>    <Type>
  219.         .
  220.         .
  221.         .
  222.  
  223. Each  line  consists  of  three entries.  The first entry will be
  224. compared  with  the destination address of the currently exported
  225. message.   If  they  match  the  message  will  be  sent  to  the
  226. nodenumber  specified  in  the  second  entry.   The  third entry
  227. represents  whether  the message flavour is going to be "normal",
  228. "crash", "direct" or "hold".
  229.  
  230. Important:
  231. ~~~~~~~~~~
  232. The  comparision rules are processed Top-Down which means that an
  233. general pattern should be the last line of the route file.
  234.  
  235. Example:
  236.  
  237. ( fido.route
  238.     "2:246/(1016|2248)(%|.#?)@fidonet                    2:246/2248.12@fidonet   Hold\n"
  239.     "2:24(07/48|6/2248).12@fidonet                       2:246/2248.12@fidonet   Hold\n"
  240.     "2:24(3/8002|50/502).22@fidonet                      2:2450/502.22@fidonet   Normal\n"
  241.     "#?@gernet                                           21:100/1202.0@gernet    Normal\n"
  242.     "#?@fidonet                                          2:246/1216.0@fidonet    Normal\n"
  243. )
  244.  
  245.  
  246.    fido.flowType (*)
  247.  
  248. Another  entry  for  nodes.  It defines which way echomailpackets
  249. are to be sent to another Fidosystem.
  250.  
  251. Possible values are:
  252.  
  253. "N" : normal
  254. "C" : crash
  255. "H" : hold
  256.  
  257. Since "N" is default, the entry may also be left out.
  258.  
  259.  
  260.    fido.arcMail (*)
  261.  
  262. If  you  set this entry to "y" then private messages will also be
  263. compressed  else  some XUT-files will be produced instead where X
  264. stands for C, D, O or H.
  265.  
  266.  
  267.    fido.pktPasswd (*)
  268.  
  269. The  header  of  a fidopacket can contain a password which can be
  270. determined  with  this  variable.   It  must  not  be more than 8
  271. characters long.
  272.  
  273.  
  274.   groupfix.subscribe (*)
  275.  
  276. This  entry  is  only  necessary if you run a node.  It lists all
  277. groupnames  this  fidosystem has access to.  Hence it is possible
  278. to define a general pattern for READACCESS (e.g.  fidonet.#?) and
  279. to  enumerate  all  groups in this entry.  A Groupfix (= AreaFix)
  280. for UMS can use it to join groups or drop them.
  281.  
  282.  
  283.   fido.dupeDir (*)
  284.  
  285. This  directory  contains messages which are recognized by UMS as
  286. dupes.   FidoImport  stores  them  in  this directory in the same
  287. format UMS-Export uses.
  288.  
  289.  
  290.   fido.importBad (*)
  291.  
  292. Set  this  entry  to  "yes"  to  allow  FidoImport to import also
  293. corrupt  messages (bad msgid, bad origin, ...).  Default is "no".
  294. The  value  of  this variable is ignored, if a variable "GATEKEY"
  295. exists.
  296.  
  297.  
  298.    fido.remap (*)
  299.  
  300. This  entry  is  only  necessary if you run a node. With its help
  301. it is possible to change the remote address of a private message.
  302. The  first two entries are compared with their equivalents in the
  303. message.  If both match the messages gets the destination address
  304. specified in the third entry.
  305.  
  306. Each line consists of:
  307.  
  308. <toname> <toaddress> <newtoaddress>
  309.  
  310. Example:
  311.  
  312. ( fido.remap
  313.     "\"Hans Wurst\" 2:246/1216.0@fidonet 2:246/1413.0@fidonet\n"
  314. )
  315.  
  316.  
  317.    fido.domain (*)
  318.  
  319. Here  you  can  specify  another domain for the generation of the
  320. message-id.  Default is ".fidonet.org".
  321.  
  322.  
  323. Installation - Hints / Examples
  324. ===============================
  325.  
  326. It  is quite handy that some entries can also be used locally for
  327. the user-entry of a Fidoboss.
  328.  
  329.  
  330. For example the relevant lines of my ums.config:
  331.  
  332. -- cut ----------------------------------------------------------
  333. ( fido.arccmd "LhA m %arcName %pktName" )
  334. ( fido.arcMail no )
  335. ( fido.ascii
  336.     "~(%|fidonet.((AMIGA|AMIPROG|AMIHARD|UMS#?).GER|AMIPOINTS.STGT))"
  337. )
  338. ( "fido.charset.ISO-8859-1" "LATIN-1" )
  339. ( fido.dearccmd "LhA -m x %dearcName %dirName" )
  340. ( fido.debuglevel 1 )
  341. ( fido.dupedir "BAD:" )
  342. ( fido.inbound "FIDOSPOOL:" )
  343. ( fido.junkcmd "Move %dearcName BAD:%dearcName.BAD" )
  344. ( fido.loglevel 4 )
  345. ( fido.mausgate "2:2452/101.6" )
  346. ( fido.nodelist "Nodelist:" )
  347. ( fido.outbound "Out:" )
  348. ( fido.reportfolder "UMSFido-Report" )
  349. ( fido.reportlevel 9 )
  350. ( fido.reportuser sysop )
  351. ( fido.rfcgate "2:243/6310.10" )
  352. ( fido.route
  353.     "2:24(07/48|6/2248).12@fidonet                       2:246/2248.12@fidonet   Hold\n"
  354.     "2:24(3/8002|50/502).22@fidonet                      2:2450/502.22@fidonet   Normal\n"
  355.     "2:24(52/207(%|.#?)|52/107.2|52/158.2|2/7.2)@fidonet 2:2452/107.2@fidonet    Normal\n"
  356.     "2:246/1401.69@fidonet                               2:246/1401.69@fidonet   Hold\n"
  357.     "3:633/359(%|.#?)@fidonet                            2:247/4.0@fidonet       Crash\n"
  358.     "#?@gernet                                           21:100/1202.0@gernet    Normal\n"
  359.     "#?@fidonet                                          2:246/1216.0@fidonet    Normal\n"
  360. )
  361. ( fido.tmpdir "tmp:" )
  362.  
  363. ( Exporter
  364.     ( Alias
  365.         fido.default
  366.     )
  367.     ( READACCESS
  368.         "fidonet.#?"
  369.     )
  370.     ( WRITEACCESS "#?" )
  371.     ( NETACCESS % )
  372.     ( IMPORT "#?" )
  373.     ( EXPORT "#?fidonet" )
  374.     ( DISTRIBUTION % )
  375.     ( Name fidonet.ibase )
  376.     ( Password  )
  377.     ( fido.localaddress "2:246/1216.42" )
  378.     ( fido.netname fidonet )
  379.     ( fido.remoteaddress "2:246/1216.0" )
  380.     ( fido.arcMail no )
  381.     ( fido.importBad yes )
  382. )
  383. -- cut ----------------------------------------------------------
  384.  
  385. The  user-entry  of  the default-Fidoboss gets an additional line
  386. <alias fido.default>.
  387.  
  388. <READACCESS>    and    <WRITEACCESS>    should   correlate   with
  389. <fido.netName>.
  390.  
  391. <IMPORT> and <NETACCESS> should at first be kept at "#?".
  392.  
  393. The  <EXPORT>  pattern  needs  some  attention.   If you merely a
  394. Fidopoint  and don´t participate in UUCP or Maus the pattern "#?"
  395. will  suffice.  Otherwise you have to choose the pattern in a way
  396. it  won´t  interfere  with  other exporters but on the other hand
  397. doesn´t  cut  out  Maus  or  UUCP  mails  if you are not directly
  398. connected to one of these networks.
  399.  
  400. I  am for instance Fidopoint and UUCP-point, therefore I chose my
  401. pattern  in  order  to  get  my Fidomail and Mausmail exported by
  402. FidoExport.   The  Mausmail  is  atomatically  being  sent to the
  403. gateway.
  404.  
  405.  
  406. Being a point at several Fidosystems
  407. ====================================
  408.  
  409. If  I  also  was  a point (e.g.  no:  4711) at the Mowgli, I also
  410. needed this user-entry:
  411.  
  412. -- cut ----------------------------------------------------------
  413. ( Exporter
  414.     ( Alias
  415.     )
  416.     ( READACCESS % )
  417.     ( WRITEACCESS "fidonet.#?" )
  418.     ( NETACCESS "#?" )
  419.     ( IMPORT "#?" )
  420.     ( EXPORT % )
  421.     ( DISTRIBUTION "#?" )
  422.     ( Name fidonet.mowgli )
  423.     ( Password  )
  424.     ( fido.localaddress "2:242/7.4711" )
  425.     ( fido.netname fidonet )
  426.     ( fido.remoteaddress "2:242/7.0" )
  427.     ( fido.arcMail no )
  428. )
  429. -- cut ----------------------------------------------------------
  430.  
  431. With  the appropriate setting of the <READACCESS> values it would
  432. be  necessary  to determine which areas are routed to which node.
  433. This  is also needed for the <EXPORT>-pattern!  The example above
  434. sets  the configuration in a way, I can only receive from Mowgli.
  435. All Mail and Echomail is still sent to IntuitionBase.
  436.  
  437.  
  438. Participation in other networks with Fido technology (e.g. GerNet)
  439. ==================================================================
  440.  
  441. If you want to participate in e.g. GerNet (because of CT.GER), you
  442. need an additional user-entry, like:
  443.  
  444.  
  445. -- cut ----------------------------------------------------------
  446. ( Exporter
  447.     ( Alias
  448.     )
  449.     ( READACCESS "gernet.#?" )
  450.     ( WRITEACCESS "gernet.#?" )
  451.     ( NETACCESS "#?" )
  452.     ( IMPORT "#?" )
  453.     ( EXPORT "#?@gernet" )
  454.     ( DISTRIBUTION "#?" )
  455.     ( Name gernet.ibase )
  456.     ( Password  )
  457.     ( fido.localaddress "21:492/132.42" )
  458.     ( fido.netname gernet )
  459.     ( fido.remoteaddress "21:492/132.0" )
  460. )
  461. -- cut ----------------------------------------------------------
  462.  
  463.  
  464. Addressing of messages
  465. ======================
  466.  
  467. Fidoaddresses   are  processed  in  the  UMS-internal  Format  by
  468. FidoImport and FidoExport.  Therefore instead of using the simple
  469. Fidoaddress  ("2:123/4.5")  you  have  to use "2:123/4.5@fidonet"
  470. ("@fidonet"  is  an  example  which  has  to be replaced with the
  471. NetName  defined  in the config.  Messages with invalid addresses
  472. can´t be sent!
  473.  
  474.  
  475. Special Features
  476. ================
  477.  
  478. In  order  to  sent  files  (Fido-Fileattach) you have to add the
  479. string  "FILE-ATTACH" in the attribute-field of the message which
  480. is  going  to  be sent with the file.  The subject of the message
  481. contains     the     filename     with     full     path    (e.g.
  482. "Mail:Uploads/AttachMe.LHA").
  483.  
  484. In  Fidonet  there  is  the  possibility to deliver personal mail
  485. directly  to  the  receiver  (or  his  Boss).   To produce such a
  486. Crash-mail  you  add  the String "URGENT" to the attribute-field.
  487. This message will then be exported as a ".CUT"-file.  Now all you
  488. have to do is to call the receiver with TrapDoor.
  489.  
  490. In  Messages which you receive via a gateway it will be attempted
  491. to recover the sender´s name and address to the original format.
  492.  
  493.  
  494. How to call FidoImport
  495. ======================
  496.  
  497. The template of FidoImport is:
  498.  
  499. NAME,PASSWORD,SERVER/K,INBOUND/K,PRESERVE/S,ID=IGNOREDUPES/S
  500.  
  501. Default-login   is   the  name  given  with  the  commandline  or
  502. "fido.default" if the commandline was empty.
  503.  
  504. Wherever  possible  a  special  login  for each Arcmail-packet is
  505. generated from the TrapDoor-filenote.  The password is "".
  506.  
  507. Furthermore  there  will  be  attempted to build a login from the
  508. sender´s  address  of  each  (3D  or 4D) packet.  The password is
  509. either the one from the packet or "".
  510.  
  511. PRESERVE tells FidoImport not to delete imported Fido packets.
  512.  
  513. By  using  parameter  IGNOREDUPES you can prevent FidoImport from
  514. producing   dupefiles  even  if  you  set  fido.dupeDir  in  your
  515. ums.config.
  516.  
  517.  
  518. How to call FidoExport
  519. ======================
  520.  
  521. The template of FidoExport is:
  522.  
  523.   USER,PASSWORD,SERVER/K
  524.  
  525.  
  526. USER  and  PASSWORD  relate  (of course) to the user-entry of the
  527. Fidoboss.    If   they   are   omitted   FidoExport  logs  in  as
  528. "fido.default" without password ("").
  529.  
  530. To export for Intuition-Base you can simply use
  531.  
  532.  FidoExport Intuition-Base
  533.  
  534. or if Intuition-Base is also "fido.default" you can use
  535.  
  536.  FidoExport
  537.  
  538.  
  539. CLI-Output from FidoImport
  540. ==========================
  541.  
  542. FidoImport  reports  not only error messages to the command line,
  543. furthermore it writes for every message a single character:
  544.  
  545. . Message was imported correctly.
  546. D dupe
  547. B Message has to be bounced.
  548. I Message was imported, even if an error occured.
  549.   (fido.importBad = yes)
  550. E another error
  551.  
  552.  
  553. Quick stepup from UMSFido 1.52 to UMSFido 2.0
  554. =============================================
  555.  
  556. This shortreference is for all those people who use UMS just as
  557. a point and who are to lazy to read throughout the whole manual.
  558.  
  559. To keep UMSFido working the way it used to you have to do the 
  560. following:
  561.  
  562. - rename fido.pointAddress to fido.localAddress 
  563. - rename fido.bossAddress to fido.remoteAddress
  564. - fido.defaultRegion, fido.createINTL can be deleted
  565. - fido.arcCmd, fido.dearcCmd, fido.junkCmd have to be changed
  566.   Example:
  567. ( fido.arccmd "LhA m %arcName %pktName" )
  568. ( fido.dearccmd "LhA -m x %dearcName %dirName" )
  569. ( fido.junkcmd "Move %dearcName BAD:%dearcName.BAD" )
  570. - set fido.importBad = "yes"
  571. - aliases of the form fido.z.n.f.p can be deleted
  572.  
  573. Private mail will only be compressed if this option is enabled by
  574. setting fido.arcMail = "yes".
  575.  
  576.  
  577. Epilog:
  578. =======
  579.  
  580. Bugreports & suggestions please to UMS.GER or directly to:
  581.  
  582.  
  583. André Schenk
  584. Tapachstraße 97 C          E-Mail: UUCP: andre@melior.s.bawue.de
  585. 70437 Stuttgart                    FIDO: 2:2471/1216.42
  586.  
  587. Kai Bolay
  588. Hoffmannstraße 168         E-Mail: UUCP: kai@studbox.uni-stuttgart.de
  589. 71229 Leonberg                     FIDO: 2:2471/1216.3
  590.  
  591. Martin Horneffer
  592. Warmweiherstraße 18        E-Mail: UUCP: maho@umshq.dfv.rwth-aachen.de
  593. 52066 Aachen                       FIDO: 2:2452/107.9
  594.                                    MAUS: AC.maus, AC2.maus
  595.  
  596.  
  597. All Flames concerning the translation to English go to:
  598.  
  599.  Michael Wenzel            E-Mail: UUCP: m_wenzel@woody.ab.mayn.sub.de
  600.                                    FIDO: 2:244/6301.8
  601.  
  602. Enjoy it!
  603.